home *** CD-ROM | disk | FTP | other *** search
/ SGI Freeware 2002 November / SGI Freeware 2002 November - Disc 1.iso / dist / fw_apache2.idb / usr / freeware / apache2 / include / util_md5.h.z / util_md5.h
C/C++ Source or Header  |  2002-07-08  |  4KB  |  113 lines
  1. /* ====================================================================
  2.  * The Apache Software License, Version 1.1
  3.  *
  4.  * Copyright (c) 2000-2002 The Apache Software Foundation.  All rights
  5.  * reserved.
  6.  *
  7.  * Redistribution and use in source and binary forms, with or without
  8.  * modification, are permitted provided that the following conditions
  9.  * are met:
  10.  *
  11.  * 1. Redistributions of source code must retain the above copyright
  12.  *    notice, this list of conditions and the following disclaimer.
  13.  *
  14.  * 2. Redistributions in binary form must reproduce the above copyright
  15.  *    notice, this list of conditions and the following disclaimer in
  16.  *    the documentation and/or other materials provided with the
  17.  *    distribution.
  18.  *
  19.  * 3. The end-user documentation included with the redistribution,
  20.  *    if any, must include the following acknowledgment:
  21.  *       "This product includes software developed by the
  22.  *        Apache Software Foundation (http://www.apache.org/)."
  23.  *    Alternately, this acknowledgment may appear in the software itself,
  24.  *    if and wherever such third-party acknowledgments normally appear.
  25.  *
  26.  * 4. The names "Apache" and "Apache Software Foundation" must
  27.  *    not be used to endorse or promote products derived from this
  28.  *    software without prior written permission. For written
  29.  *    permission, please contact apache@apache.org.
  30.  *
  31.  * 5. Products derived from this software may not be called "Apache",
  32.  *    nor may "Apache" appear in their name, without prior written
  33.  *    permission of the Apache Software Foundation.
  34.  *
  35.  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
  36.  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  37.  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  38.  * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
  39.  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  40.  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  41.  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  42.  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  43.  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  44.  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  45.  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  46.  * SUCH DAMAGE.
  47.  * ====================================================================
  48.  *
  49.  * This software consists of voluntary contributions made by many
  50.  * individuals on behalf of the Apache Software Foundation.  For more
  51.  * information on the Apache Software Foundation, please see
  52.  * <http://www.apache.org/>.
  53.  *
  54.  * Portions of this software are based upon public domain software
  55.  * originally written at the National Center for Supercomputing Applications,
  56.  * University of Illinois, Urbana-Champaign.
  57.  */
  58.  
  59. #ifndef APACHE_UTIL_MD5_H
  60. #define APACHE_UTIL_MD5_H
  61.  
  62. #ifdef __cplusplus
  63. extern "C" {
  64. #endif
  65.  
  66. /**
  67.  * @package Apache MD5 library
  68.  */
  69.  
  70. #include "apr_md5.h"
  71.  
  72. /**
  73.  * Create an MD5 checksum of a given string
  74.  * @param a Pool to allocate out of
  75.  * @param string String to get the checksum of
  76.  * @return The checksum
  77.  * @deffunc char *ap_md5(apr_pool_t *a, const unsigned char *string)
  78.  */
  79. AP_DECLARE(char *) ap_md5(apr_pool_t *a, const unsigned char *string);
  80.  
  81. /**
  82.  * Create an MD5 checksum of a string of binary data
  83.  * @param a Pool to allocate out of
  84.  * @param buf Buffer to generate checksum for
  85.  * @param len The length of the buffer
  86.  * @return The checksum
  87.  * @deffunc char *ap_md5_binary(apr_pool_t *a, const unsigned char *buf, int len)
  88.  */
  89. AP_DECLARE(char *) ap_md5_binary(apr_pool_t *a, const unsigned char *buf, int len);
  90.  
  91. /**
  92.  * Convert an MD5 checksum into a base64 encoding
  93.  * @param p The pool to allocate out of
  94.  * @param context The context to convert
  95.  * @return The converted encoding
  96.  * @deffunc char *ap_md5contextTo64(apr_pool_t *p, apr_md5_ctx_t *context)
  97.  */
  98. AP_DECLARE(char *) ap_md5contextTo64(apr_pool_t *p, apr_md5_ctx_t *context);
  99.  
  100. /**
  101.  * Create an MD5 Digest for a given file
  102.  * @param p The pool to allocate out of
  103.  * @param infile The file to create the digest for
  104.  * @deffunc char *ap_md5digest(apr_pool_t *p, apr_file_t *infile)
  105.  */
  106. AP_DECLARE(char *) ap_md5digest(apr_pool_t *p, apr_file_t *infile);
  107.  
  108. #ifdef __cplusplus
  109. }
  110. #endif
  111.  
  112. #endif    /* !APACHE_UTIL_MD5_H */
  113.